Hub Sante AMQP API 0.7

L'API Hub Sante AMQP permet le partage d'informations entre acteurs du monde de la santé.

Servers

  • localhost:5671amqps 0-9-1local

    Instance locale du Hub Sante portée par minikube dans le repo du Hub

    Security:
    • X509:

      Un certificat issu d'une AC validée par le Hub est nécessaire pour l'authentification mTLS

  • hubsante.esante.gouv.fr:5671amqps 0-9-1remote

    Instance "bac à sable" du Hub Sante déployée dans le Cloud.

    Security:
    • X509:

      Un certificat issu d'une AC validée par le Hub est nécessaire pour l'authentification mTLS

Operations

  • SUB {clientId}.in.ack

    File spécifique à chaque client pour la réception des acquittements fonctionnels

    Acquittement fonctionnel

    Operation IDreceiveAck
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts the following message:

    Message au standard EDXLedxlMessage

    Message au standard EDXL transportable par le Hub, comportant une partie adressage et une partie contenu. La partie contenu peut respecter différentes spécifications fonctionnelles.

    restricted any
    uid: EdxlMessage

    Examples

  • SUB {clientId}.in.info

    File spécifique à chaque client pour la réception des informations complémentaires liées au fonctionnement et aux échanges portés par le Hub Santé

    Informations complémentaires

    Operation IDreceiveInfo
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts the following message:

    Message au standard EDXLedxlMessage

    Message au standard EDXL transportable par le Hub, comportant une partie adressage et une partie contenu. La partie contenu peut respecter différentes spécifications fonctionnelles.

    restricted any
    uid: EdxlMessage

    Examples

  • SUB {clientId}.in.message

    File spécifique à chaque client pour la réception de messages

    Message fonctionnel

    Operation IDreceiveMessage
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts the following message:

    Message au standard EDXLedxlMessage

    Message au standard EDXL transportable par le Hub, comportant une partie adressage et une partie contenu. La partie contenu peut respecter différentes spécifications fonctionnelles.

    restricted any
    uid: EdxlMessage

    Examples

  • PUB {clientId}.out.ack

    File spécifique à chaque client pour l'envoi des acquittements fonctionnels

    Acquittement fonctionnel

    Operation IDpublishAck
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts the following message:

    Message au standard EDXLedxlMessage

    Message au standard EDXL transportable par le Hub, comportant une partie adressage et une partie contenu. La partie contenu peut respecter différentes spécifications fonctionnelles.

    restricted any
    uid: EdxlMessage

    Examples

  • PUB {clientId}.out.info

    File spécifique à chaque client pour l'envoi des informations complémentaires liées au fonctionnement et aux échanges portés par le Hub Santé

    Informations complémentaires

    Operation IDpublishInfo
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts the following message:

    Message au standard EDXLedxlMessage

    Message au standard EDXL transportable par le Hub, comportant une partie adressage et une partie contenu. La partie contenu peut respecter différentes spécifications fonctionnelles.

    restricted any
    uid: EdxlMessage

    Examples

  • PUB {clientId}.out.message

    File spécifique à chaque client pour l'envoi de messages

    Message fonctionnel

    Operation IDpublishMessage
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts the following message:

    Message au standard EDXLedxlMessage

    Message au standard EDXL transportable par le Hub, comportant une partie adressage et une partie contenu. La partie contenu peut respecter différentes spécifications fonctionnelles.

    restricted any
    uid: EdxlMessage

    Examples

Messages

  • #1Message au standard EDXLedxlMessage

    Message au standard EDXL transportable par le Hub, comportant une partie adressage et une partie contenu. La partie contenu peut respecter différentes spécifications fonctionnelles.

    restricted any
    uid: EdxlMessage

Schemas

  • restricted any
    uid: Content
  • oneOf
    uid: ContentObject
  • restricted any
    uid: ContentXML
  • object
    uid: CreateCaseMessage
  • restricted any
    uid: Descriptor
  • DistributionKind
    string
    uid: DistributionKind
      Allowed values:
    • "Report"
    • "Update"
    • "Cancel"
    • "Request"
    • "Response"
    • "Dispatch"
    • "Ack"
    • "Error"
    • "SensorConfiguration"
    • "SensorControl"
    • "SensorStatus"
    • "SensorDetection"
    • "Unknown"
    • "NoAppropriateDefault"
  • DistributionStatus
    string
    uid: DistributionStatus
      Allowed values:
    • "Actual"
    • "Exercise"
    • "System"
    • "Test"
    • "Unknown"
    • "NoAppropriateDefault"
  • restricted any
    uid: EdxlMessage
  • oneOf
    uid: EmbeddedJsonContent
  • oneOf
    uid: EmbeddedXMLContent
  • restricted any
    uid: ExplicitAddress
  • restricted any
    uid: GenericAckMessage
  • restricted any
    uid: JsonContent
  • object
    uid: access
  • object
    uid: additionalInformation
  • object
    uid: address
  • object
    uid: alert
  • object
    uid: alertCode
  • object
    uid: alertSource
      Examples values:
    • {"channel":"Person","dialledURI":"tel:18"}
  • object
    uid: callTaker
      Examples values:
    • {"calltakerId":"id1234, carte CPx (Santé), id d'affectation, …","calltakerURI":"0303030303","controlRoom":"CGA, CGO 21, CRRA 44, ...","organization":"SDIS, SAMU, …"}
  • object
    uid: caller
  • object
    uid: callerName
      Examples values:
    • {"callerFirstName":"Jean","callerLastName":"Dupont","complete":"Jean Dupont"}
  • object
    uid: casualties
  • object
    uid: city
      Examples values:
    • {"details":"Quartie Melun Nord, Lhomme, …","inseeCode":59350,"name":"Lille"}
  • object
    uid: coord
      Examples values:
    • {"heading":96,"height":120,"lat":"48.866667","lon":"2.333333","precision":"Adresse","speed":34,"time":"2022-09-27T08:23:34+02:00"}
  • object
    uid: customMap
      Examples values:
    • {"details":"Précision sur le quartier d'intervention","key":"neighborhood","label":"Quartier","value":"SECT.QUARTIER HISTORIQUE"}
  • object
    uid: geometry
  • object
    uid: identifier
      Examples values:
    • {"source":"NIR, SINUS, SI-VIC, …","value":"id1234"}
  • object
    uid: location
  • object
    uid: nomenclature
      Examples values:
    • {"code":"C07.13.02","comment":"None","label":"Rodéo automobile"}
  • object
    uid: object
      Examples values:
    • {}
  • object
    uid: point
  • object
    uid: resource
      Examples values:
    • {"URI":"None","derefURI":"None","digest":"None","mimeType":"PDF, XML, JPEG, …","resourceDesc":"photo, carte, …","size":"1235, 35, …"}
  • object
    uid: victims
      Examples values:
    • {"comment":"Jeanne Dupont, 6 ans, ne répond plus","count":"SEVERAL","mainVictim":"CHILD"}
  • object
    uid: wayName
      Examples values:
    • {"complete":"A1 direction Paris, Bd du Montparnasse","name":"du Montparnasse","type":"Boulevard"}